<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.4"/>
<title>MPCDI Library: mpcdi::Writer Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="scalable_logo.gif"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">MPCDI Library
   </div>
   <div id="projectbrief">MPCDI  Reader/Writer/Creater/Validator/etc.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.4 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classmpcdi_1_1_writer.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Pages</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classmpcdi_1_1_writer-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">mpcdi::Writer Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
</div><!--header-->
<div class="contents">

<p>An MPCDI <a class="el" href="classmpcdi_1_1_writer.html" title="An MPCDI Writer Wrapper. ">Writer</a> Wrapper.  
 <a href="classmpcdi_1_1_writer.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="mpcdi_writer_8h_source.html">mpcdiWriter.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for mpcdi::Writer:</div>
<div class="dyncontent">
 <div class="center">
  <img src="classmpcdi_1_1_writer.png" usemap="#mpcdi::Writer_map" alt=""/>
  <map id="mpcdi::Writer_map" name="mpcdi::Writer_map">
<area href="classmpcdi_1_1_writer_intern.html" title="Internal Functions for the Writer. " alt="mpcdi::WriterIntern" shape="rect" coords="0,56,117,80"/>
</map>
 </div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a2cba7e3329382c2e1eee10bd87c766f3"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespacempcdi.html#acd4b0b3107b2a04ec04ba94b834fd881">MPCDI_Error</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmpcdi_1_1_writer.html#a2cba7e3329382c2e1eee10bd87c766f3">Write</a> (std::string FileName, <a class="el" href="structmpcdi_1_1_profile.html">mpcdi::Profile</a> &amp;profile)=0</td></tr>
<tr class="separator:a2cba7e3329382c2e1eee10bd87c766f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af60bc3e568113df143769964ef3944c2"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmpcdi_1_1_writer.html#af60bc3e568113df143769964ef3944c2">mpcdiSetMacro</a> (OverwriteExistingFile, bool)</td></tr>
<tr class="separator:af60bc3e568113df143769964ef3944c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a01c0865ec21257a331f523723e0236b6"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmpcdi_1_1_writer.html#a01c0865ec21257a331f523723e0236b6">mpcdiGetConstMacro</a> (OverwriteExistingFile, bool)</td></tr>
<tr class="separator:a01c0865ec21257a331f523723e0236b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6a39c0e7829c2c6f8bac86d324d256ef"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmpcdi_1_1_writer.html#a6a39c0e7829c2c6f8bac86d324d256ef">mpcdiSetMacro</a> (DoProfileValidation, bool)</td></tr>
<tr class="separator:a6a39c0e7829c2c6f8bac86d324d256ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae903d7ae2b9846caa2b091038396585d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmpcdi_1_1_writer.html#ae903d7ae2b9846caa2b091038396585d">mpcdiGetConstMacro</a> (DoProfileValidation, bool)</td></tr>
<tr class="separator:ae903d7ae2b9846caa2b091038396585d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:aacdf5fc415eac40354826f9d7c33b782"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classmpcdi_1_1_writer.html">Writer</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmpcdi_1_1_writer.html#aacdf5fc415eac40354826f9d7c33b782">CreateWriter</a> ()</td></tr>
<tr class="separator:aacdf5fc415eac40354826f9d7c33b782"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a7b53253652143ce1526053c7e78db98d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmpcdi_1_1_writer.html#a7b53253652143ce1526053c7e78db98d">m_OverwriteExistingFile</a></td></tr>
<tr class="separator:a7b53253652143ce1526053c7e78db98d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a06f7209836ca20fa0e24e5b5d24f8e98"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmpcdi_1_1_writer.html#a06f7209836ca20fa0e24e5b5d24f8e98">m_DoProfileValidation</a></td></tr>
<tr class="separator:a06f7209836ca20fa0e24e5b5d24f8e98"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>An MPCDI <a class="el" href="classmpcdi_1_1_writer.html" title="An MPCDI Writer Wrapper. ">Writer</a> Wrapper. </p>
<dl class="section rcs"><dt>Date:</dt><dd>2012-02-08 11:39:41 -0500 (Wed, 08 Feb 2012) </dd></dl>
<dl class="section rcs"><dt>Revision:</dt><dd>18341 </dd></dl>
<p>Some comments on future compatibility. This implementation was written for version 1, draft 15 of the MCPDI standard. It seems likely there will be new versions in the future. The committee has not yet decided how future/backwards compatibility will be handled. This code makes the guess that extra tags will simply be added. That is,</p>
<p>.AUTHOR Scalable <a class="el" href="structmpcdi_1_1_display.html" title="A Collection of Buffers. ">Display</a> Technologies, Inc. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="aacdf5fc415eac40354826f9d7c33b782"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classmpcdi_1_1_writer.html">Writer</a> * Writer::CreateWriter </td>
          <td>(</td>
          <td class="paramname">)</td><td></td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>creates a writer object </p>

</div>
</div>
<a class="anchor" id="a01c0865ec21257a331f523723e0236b6"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">mpcdi::Writer::mpcdiGetConstMacro </td>
          <td>(</td>
          <td class="paramtype">OverwriteExistingFile&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="ae903d7ae2b9846caa2b091038396585d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">mpcdi::Writer::mpcdiGetConstMacro </td>
          <td>(</td>
          <td class="paramtype">DoProfileValidation&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="af60bc3e568113df143769964ef3944c2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">mpcdi::Writer::mpcdiSetMacro </td>
          <td>(</td>
          <td class="paramtype">OverwriteExistingFile&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Should we overwrite an existing file? Default: yes (on error, will return MPCDI_FILE_ALREADY_EXISTS) </p>

</div>
</div>
<a class="anchor" id="a6a39c0e7829c2c6f8bac86d324d256ef"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">mpcdi::Writer::mpcdiSetMacro </td>
          <td>(</td>
          <td class="paramtype">DoProfileValidation&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>should we validate the profile before writing default: true </p>

</div>
</div>
<a class="anchor" id="a2cba7e3329382c2e1eee10bd87c766f3"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="namespacempcdi.html#acd4b0b3107b2a04ec04ba94b834fd881">MPCDI_Error</a> mpcdi::Writer::Write </td>
          <td>(</td>
          <td class="paramtype">std::string&#160;</td>
          <td class="paramname"><em>FileName</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structmpcdi_1_1_profile.html">mpcdi::Profile</a> &amp;&#160;</td>
          <td class="paramname"><em>profile</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>The several different ways to Write. </p>

<p>Implemented in <a class="el" href="classmpcdi_1_1_writer_intern.html#a40ff81028e87c0260ac1eb56dc5a6d81">mpcdi::WriterIntern</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a06f7209836ca20fa0e24e5b5d24f8e98"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool mpcdi::Writer::m_DoProfileValidation</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="a7b53253652143ce1526053c7e78db98d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool mpcdi::Writer::m_OverwriteExistingFile</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Member variables </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/IO/<a class="el" href="mpcdi_writer_8h_source.html">mpcdiWriter.h</a></li>
<li>src/IO/<a class="el" href="mpcdi_writer_intern_8cpp.html">mpcdiWriterIntern.cpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="namespacempcdi.html">mpcdi</a></li><li class="navelem"><a class="el" href="classmpcdi_1_1_writer.html">Writer</a></li>
    <li class="footer">Generated on Thu Aug 15 2013 13:49:02 for MPCDI Library by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.4 </li>
  </ul>
</div>
</body>
</html>
